-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore: Update v2 docs #239
Conversation
6696d08
to
d6fac07
Compare
rest_indexer=REST_URL, | ||
websocket_indexer=WEBSOCKET_URL | ||
node_url="dydx-ops-grpc.kingnodes.com:443", # No 'https://' prefix | ||
rest_indexer="https://indexer.v4.dydx.exchange", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Christopher-Li are we okay with suggesting indexer endpoints via docs? if so this looks like a pretty solid upgrade from our current documentation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@samtin0x i'd prefer if we keep these listed as variable names and instead link to https://docs.dydx.exchange/infrastructure_providers-network/resources#indexer-endpoints.
This will make the docs more durable to changes in indexer endpoints and also let developers know that they can set up their own indexer or node urls
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, both approaches work. As long as users/devs have a simple example they can copy paste and get quickstarted, as that has been the main blocker here, hence the PR
eb2de48
to
3bfd0f8
Compare
rest_indexer=REST_URL, | ||
websocket_indexer=WEBSOCKET_URL | ||
node_url="NODE_URL", # No 'https://' prefix | ||
rest_indexer="REST_INDEXER", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nit] should still be descriptive of the data type REST_INDEXER_URL
3bfd0f8
to
50cb3f1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perfect 🔥
No description provided.